﻿/****************************************************************************************************
	Copyright (C) 2010 RapidWebDev Organization (http://rapidwebdev.org)
	Author: Eunge, Legal Name: Jian Liu, Email: eunge.liu@RapidWebDev.org

	This program is free software: you can redistribute it and/or modify
	it under the terms of the GNU General Public License as published by
	the Free Software Foundation, either version 2 of the License, or
	(at your option) any later version.

	This program is distributed in the hope that it will be useful,
	but WITHOUT ANY WARRANTY; without even the implied warranty of
	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
	GNU General Public License for more details.

	You should have received a copy of the GNU General Public License
	along with this program.  If not, see <http://www.gnu.org/licenses/>.
 ****************************************************************************************************/

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using RapidWebDev.SearchIndex.Contract;

namespace RapidWebDev.SearchIndex
{
	/// <summary>
	/// The interface to pull indexing messages from somewhere for index service.
	/// </summary>
	public interface IIndexMessageCoordinator
	{
		/// <summary>
		/// Get index queues.
		/// </summary>
		/// <returns></returns>
		IEnumerable<IndexQueue> GetIndexQueues();

		/// <summary>
		/// Read indexing documents from index queue.
		/// </summary>
		/// <param name="indexQueue">Index queue</param>
		/// <returns></returns>
		IEnumerable<IndexDocMessage> Read(IndexQueue indexQueue);

		/// <summary>
		/// Start indexing on the document.
		/// </summary>
		/// <param name="indexQueue">Index queue</param>
		/// <param name="indexDocMessage">Indexing document</param>
		void StartIndexing(IndexQueue indexQueue, IndexDocMessage indexDocMessage);

		/// <summary>
		/// Complete the indexing for document by id.
		/// </summary>
		/// <param name="indexQueue">Index queue.</param>
		/// <param name="indexDocId">The id of index doc in queue.</param>
		void Complete(IndexQueue indexQueue, Guid indexDocId);

		/// <summary>
		/// Log an exception for the document by id.
		/// </summary>
		/// <param name="indexQueue">Index queue.</param>
		/// <param name="indexDocId">The id of index doc in queue.</param>
		/// <param name="exception">The exception message.</param>
		void LogException(IndexQueue indexQueue, Guid indexDocId, string exception);
	}
}